Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Include jobId in webhook messages #15704

Merged
merged 1 commit into from
Aug 16, 2022
Merged

Include jobId in webhook messages #15704

merged 1 commit into from
Aug 16, 2022

Conversation

akawalsky
Copy link
Contributor

What

For Custom Webhook integrations, it would be extremely helpful to include the jobId in the success and error messages. From here, we will be able to do further operations and reporting using the Airbyte API. Ideally, this message would be a configurable JSON, but due to the fact that the only available webhook solution is a raw string message, this feels like the best compromise.

Also, it seems there is a precedence for "hacking" the webhook due to this comment in the code - https://github.com/airbytehq/airbyte/blob/master/airbyte-scheduler/scheduler-persistence/src/main/java/io/airbyte/scheduler/persistence/JobNotifier.java#L97

How

Include Job ID: %s at the bottom of success_slack_notification_template.txt and failure_slack_notification_template.txt

Recommended reading order

  1. JobNotifier.java
  2. everything else

🚨 User Impact 🚨

Unsure if this could be a breaking change - if someone is parsing the webhook message in an unsafe way then it could break their integration. Does that count as breaking? 🚨

Pre-merge Checklist

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

  • Community member? Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
    • docs/integrations/README.md
    • airbyte-integrations/builds.md
  • PR name follows PR naming conventions

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • If new credentials are required for use in CI, add them to GSM. Instructions.
  • /test connector=connectors/<name> command is passing
  • New Connector version released on Dockerhub by running the /publish command described here
  • After the connector is published, connector added to connector index as described here
  • Seed specs have been re-generated by building the platform and committing the changes to the seed spec files, as described here
Updating a connector

Community member or Airbyter

  • Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • Changelog updated in docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
  • PR name follows PR naming conventions

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • If new credentials are required for use in CI, add them to GSM. Instructions.
  • /test connector=connectors/<name> command is passing
  • New Connector version released on Dockerhub and connector version bumped by running the /publish command described here
Connector Generator
  • Issue acceptance criteria met
  • PR name follows PR naming conventions
  • If adding a new generator, add it to the list of scaffold modules being tested
  • The generator test modules (all connectors with -scaffold in their name) have been updated with the latest scaffold by running ./gradlew :airbyte-integrations:connector-templates:generator:testScaffoldTemplates then checking in your changes
  • Documentation which references the generator is updated as needed

Tests

Unit

Put your unit tests output here.

Integration

Put your integration tests output here.

Acceptance

Put your acceptance tests output here.

@github-actions github-actions bot added area/platform issues related to the platform area/scheduler labels Aug 16, 2022
lmossman
lmossman approved these changes Aug 16, 2022
View reviewed changes
Copy link
Contributor

@lmossman lmossman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems reasonable to me!

@lmossman lmossman merged commit f0a69c4 into airbytehq:master Aug 16, 2022
@octavia-squidington-iii octavia-squidington-iii mentioned this pull request Aug 19, 2022
Closed
@evantahler evantahler mentioned this pull request Aug 22, 2022
Merged
rodireich pushed a commit that referenced this pull request Aug 25, 2022
@akawalsky @rodireich
Include jobId in webhook messages (#15704)
1317a61
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lmossman lmossman lmossman approved these changes

Assignees
No one assigned
Labels
area/platform issues related to the platform area/scheduler community
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@akawalsky @lmossman @octavia-squidington-iii